feat(content, port): Port vitamin-based allergies and cannibalism from DDA #5808

RobbieNeko · 2024-12-13T22:25:44Z

Checklist

Required

I wrote the PR title in conventional commit format.
I ran the code formatter.
I linked any relevant issues using github keyword syntax so it can be closed automatically.
I have committed my changes to new branch that isn't main so it won't cause conflict when updating main branch later.

Optional

This PR ports commits from DDA or other cataclysm forks.
- I have attributed original authors in the commit messages adding Co-Authored-By in the commit message.
- I have linked the URL of original PR(s) in the description.
This is a C++ PR that modifies JSON loading or behavior.
- If documentation for this feature does not exist, please write it or at least note its lack in PR description.

Purpose of change

Fixes #5613 and many requests for them to be ported by porting the following DDA PRs:
Cannibalism checks as a vitamin
Vitamin-based allergy

This should greatly improve user experience for anyone with traits regarding dietary restrictions, and also in theory allows us to cut back on any bloated food variants that are just about providing options for certain dietary restrictions.

Describe the solution

Ports the PRs mentioned above
Uses the same script as used for the latter DDA PR in order to apply the vitamins for allergies automatically (a link to the repo for said script can be found in said DDA PR)
Enforces the convention of materials always being contained in an array for food-related materials
- This is necessary for the script to function, and also just a nice change for consistency.

Describe alternatives you've considered

Implode
Reinvent the wheel
Wait for someone else to do it
Leave out the formatting change and instead create an altered version of the script
- While more-atomic commits are nice, I don't see the harm in doing a bit of necessary formatting here when it's as easy as some find-replace work. Besides, standardization is good. ~~Also, this way I don't have to learn typescript or make an entirely new python script for this~~

Testing

It builds on my machine
It loads (after making condition_type an enum class so that we don't have namespace collision with vitamins.h VITAMIN), and it indeed behaves appropriately with dietary restrictions!
It works without Simplified Nutrition as well, which is good.

Herbivores can't eat meat:

Carnivores can't eat veggies:

It works without Simplified Nutrition:

Additional context

Basic documentation added at request of Scarf
Haven't tested Cannibalism yet, but I assume it works

Co-Authored-By: RenechCDDA <[email protected]>

Co-Authored-By: Anton Simakov <[email protected]>

Co-Authored-By: Antti Riikonen <[email protected]>

Oops, didn't realize that the script for the other vitamins didn't include cannibalism Co-Authored-By: RenechCDDA <[email protected]>

Co-Authored-By: Antti Riikonen <[email protected]>

Enforces the idea that materials should always be in arrays even if there's only one, specifically for the food-related materials. This is necessary for the vitamins script to work correctly. Also does that 2nd pass of the vitamins script Co-Authored-By: Antti Riikonen <[email protected]>

data/json/vitamin.json

The DDA script apparently just didn't touch nuts?

We don't even HAVE bread material!

To appease the scarf

autofix-ci · 2024-12-14T02:04:56Z

Autofix has formatted code style violation in this PR.

I edit commits locally (e.g: git, github desktop) and want to keep autofix

Run git pull. this will merge the automated commit into your local copy of the PR branch.
Continue working.

I do not want the automated commit

Format your code locally, then commit it.
Run git push --force to force push your branch. This will overwrite the automated commit on remote with your local one.
Continue working.

If you don't do this, your following commits will be based on the old commit, and cause MERGE CONFLICT.

RobbieNeko · 2024-12-14T02:06:43Z

Thank you Tree of formatting

RobbieNeko · 2024-12-14T03:34:06Z

The Windows build is attempting to pocket-veto the PR via refusing to actually end tests lmao

RoyalFox2140

I think it's fine, it seems to work. But This needs more reviewers. It's 2000 lines.

KheirFerrum · 2024-12-16T13:27:04Z

I'm looking at the changes to the "material" definitions in the JSONs and wondering if anything done to the cpp necessitates it.

If it does, I'll need to suggest some changes to the cpp to use assigns or something to maintain the old method of defining materials, otherwise this will require a lot of tedious rewriting of JSONs for no reason in every mod available to BN.

~~If it doesn't, then I'd suggest removing those changes to the JSON as they are not necessary and may end up confusing.~~

Edit: I've been told the changes are purely JSON side and are necessary for a script to add nutrients to food. As this doesn't change how the game loads cpp older 1-entry material definitions will still function so I'm good with it.

Zlorthishen · 2024-12-16T23:24:52Z

I compiled this locally and it works for Windows 11.

I confirmed that:

Herbivores refused to eat meat
Carnivores refused to eat any plant
Hates Fruit refused to eat any fruit, but would eat other plants without the allergen_fruit
Cannable works

RoyalFox2140 · 2024-12-17T01:29:07Z

I think this is safe to merge. Kheir and Scarf have both looked at it somewhat, it's been compile tested a few times. We can fix anything missed later in post.

src/consumption.cpp

RobbieNeko and others added 7 commits December 11, 2024 21:14

Port Cannibalism vitamin first

f663264

Co-Authored-By: RenechCDDA <[email protected]>

Port the rest of the vitamin-based allergies

7fa077a

Co-Authored-By: Anton Simakov <[email protected]>

Give the vitamins to the vanilla food items

4f764d3

Co-Authored-By: Antti Riikonen <[email protected]>

Add cannibalism vitamins

6f0c740

Oops, didn't realize that the script for the other vitamins didn't include cannibalism Co-Authored-By: RenechCDDA <[email protected]>

Add vitamins to in-repo mods

d202c92

Co-Authored-By: Antti Riikonen <[email protected]>

Fix errors related to condition_type

71e63af

github-actions bot added src changes related to source code. JSON related to game datas in JSON format. mods PR changes related to mods. labels Dec 13, 2024

RoyalFox2140 reviewed Dec 13, 2024

View reviewed changes

data/json/vitamin.json Outdated Show resolved Hide resolved

Fix tests and junk vitamin name

380533b

github-actions bot added the tests changes related to tests label Dec 13, 2024

RobbieNeko added 4 commits December 13, 2024 19:20

Fix the rest of the consumption tests

6ef54c7

Add nut allergen

df843ec

The DDA script apparently just didn't touch nuts?

Remove DDA bread allergy

714e71c

We don't even HAVE bread material!

Add very basic allergies documentation

86d01b3

To appease the scarf

github-actions bot added the docs PRs releated to docs page label Dec 14, 2024

style(autofix.ci): automated formatting

c9be7c1

RoyalFox2140 approved these changes Dec 14, 2024

View reviewed changes

RoyalFox2140 requested a review from chaosvolt December 16, 2024 04:24

RoyalFox2140 merged commit 43d2a72 into cataclysmbnteam:main Dec 17, 2024
12 checks passed

scarf005 reviewed Dec 17, 2024

View reviewed changes

src/consumption.cpp Show resolved Hide resolved

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

feat(content, port): Port vitamin-based allergies and cannibalism from DDA #5808

feat(content, port): Port vitamin-based allergies and cannibalism from DDA #5808

RobbieNeko commented Dec 13, 2024 •

edited

Loading

autofix-ci bot commented Dec 14, 2024

RobbieNeko commented Dec 14, 2024

RobbieNeko commented Dec 14, 2024

RoyalFox2140 left a comment

KheirFerrum commented Dec 16, 2024 •

edited

Loading

Zlorthishen commented Dec 16, 2024 •

edited

Loading

RoyalFox2140 commented Dec 17, 2024

feat(content, port): Port vitamin-based allergies and cannibalism from DDA #5808

feat(content, port): Port vitamin-based allergies and cannibalism from DDA #5808

Conversation

RobbieNeko commented Dec 13, 2024 • edited Loading

Checklist

Required

Optional

Purpose of change

Describe the solution

Describe alternatives you've considered

Testing

Additional context

autofix-ci bot commented Dec 14, 2024

RobbieNeko commented Dec 14, 2024

RobbieNeko commented Dec 14, 2024

RoyalFox2140 left a comment

Choose a reason for hiding this comment

KheirFerrum commented Dec 16, 2024 • edited Loading

Zlorthishen commented Dec 16, 2024 • edited Loading

RoyalFox2140 commented Dec 17, 2024

RobbieNeko commented Dec 13, 2024 •

edited

Loading

KheirFerrum commented Dec 16, 2024 •

edited

Loading

Zlorthishen commented Dec 16, 2024 •

edited

Loading